===============
== Menu Vote ==
===============

About:
======

Menu vote was originally called Gamepoint 
Vote. I wrote the mutator Gamepoint Vote 
for the Online Gaming Company GamePoint 
for which I am an Unreal Tournament
admin. You can find Gamepoint at:
http://www.gamepoint.net/
After GamePoint Vote was finished I 
felt the community could benefit from this 
tool so I decided to release it. Since 
then however, a lot of time has passed 
so I'm not sure if it's still as 
unique as it was when GamepointVote was 
finished.

Client side installation:
=========================

Install the mutator by unzipping the 
following files into their appropriate 
folders:

MenuVote.int -> UnrealTournament\System
MenuVote.u -> UnrealTournament\System
MenuVoteConfig.int -> UnrealTournament\System
MenuVoteConfig.u -> UnrealTournament\System
Menu Vote Readme.txt -> UnrealTournament\Help

Server side installation:
=========================

Install the mutator on the server by 
unzipping the following files into their 
appropriate folders:

MenuVote.int -> UnrealTournament\System
MenuVote.u -> UnrealTournament\System

The other files are not needed for a 
server.

Also, you need to make 
sure that these line is added in the 
UnrealTournament.ini of your server 
under the [Engine.GameEngine] header:

ServerPackages=MenuVote

This will make sure that 
clients who do not have 
Menu vote installed will 
download it automatically.

Server side Configuration:
==========================

Configuring Menu Vote is done trough a 
menu. You do this by first installing 
Menu Vote locally on your PC and using 
the Menu Vote mod menu to configure 
the mutator. That configuration is stored 
in the MenuVote.ini file, which you copy 
to your server.

Here is a rundown of what each option 
does.

From the options tab:
=====================

Vote for frag limit:
If you check this box, players will be 
able to change the frag limit by voting.

Vote for the time limit:
If you check this box, players will be 
able to change the time limit by voting.

Vote for game types:
If you check this box, players will be 
able to change the game type by voting.

Vote for maps:
If you check this box, players will be 
able to change the map by voting.

Vote for force respawn:
If you check this box, players will be 
able to toggle force respawn by voting.

Vote for maximum players:
If you check this box, players will be 
able to change the maximum amount of 
players in the game by voting.

Vote for maximum spectators:
If you check this box, players will be 
able to change the maximum amount of 
spectators in the game by voting.

Vote for translocators:
If you check this box, players will be 
able to toggle the use of translocators
by voting.

Vote for tournament mode:
If you check this box, players will be 
able to toggle the tournament mode
by voting.

Vote for weapon stay:
If you check this box, players will be 
able to toggle weapon stay
by voting.

Vote for friendly fire:
If you check this box, players will be 
able to change the amount of friendly 
fire by voting.

Vote to kick someone:
If you check this box, players will be 
able to kick a player by voting.

Vote to mute spectators:
If you check this box, players will be 
able to toggle the muting of spectators 
by voting.

Percentage to pass:
This is the percentage of the players
that has to agree with the vote starter 
for the vote to be accepted. 0 is 0%, 
100 is 100% for example a value of 60
for 60% of the players.

Maximum players:
The greatest value that the maximum players 
variable can be set for by voting. This 
option is only usefull when the Vote for 
maximum players box is checked.

Maximum spectators:
The greatest value that the maximum spectators 
variable can be set for by voting. This 
option is only usefull when the Vote for 
maximum spectators box is checked.

From the maps tab:
=====================

In this tab you can select the maps 
that can be voted for for each 
gametype. If the Vote for maps box 
from the previous tab is not checked, 
then this settings do not have any 
effect. 

There are six different lists of 
maps that you can set. Five of the 
lists represent the different 
standard UT gametypes. When playing 
a game with that particular gametype 
on, the appropriate map list will be 
used. For example, when playing a 
Team Deathmatch game, only the maps 
from the Teamdeathmatch tab will be 
allowed for voting. 
For all games that don't use the standard 
UT gametypes there is the Custom 
tab. In this tab you can select any 
map that is in your Maps directory. 
Any gametype that is not a standard 
UT gametype will use this map list.
You can add or remove maps from a 
map list the same way you would 
normally use to change a map list 
in UT: just double click the map 
name to make it go to the other 
section. The maps on the left side 
are excluded from the map list, 
whereas a map on the right side is 
included in the map list.

If you want to allow a map for voting 
that is not installed locally but that 
is installed on the server, you can open 
the MenuVote.ini file in a text editor 
and change the maps from the appropriate 
map list manually.

From the gametypes tab:
=======================

There are several steps to configuring a new 
gametype. Follow these steps and your 
gametype voting will be up and running in 
no-time.

- Select the game mode that this type will use 
  with the dropdown menu. If you want this gametype 
  to use a custom gametype, select that and then 
  fill out the gametype details in the textbox 
  that will come up as soon as you select 
  custom.

- Enter a description in the appropriate box. 
  The description is what players will see 
  in-game when voting for a gametype.
  
- Select if weaponstay should be turned on or off 
  for this gametype.
  
- Select if the tournament mode should be turned 
  on or off for this gametype.
 
- Enter the fraglimit for this gametype. This will 
  be used as the capture limit or the goalteamscore 
  in teamgames.

- Enter the timelimit for this gametype.

- Enter the map that will be switched to when starting 
  this gametype.

- Enter the maximum amount of players that will be used
  for this gametype.
  
- Click the Mutator Configuration Trough Menu button, 
  and select the mutators that will be used with this 
  gametype by double clicking on their names. You don't 
  have to include Menu Vote, that will be done automatically.
 
- Select a slot for this gametype.

- Hit the save button.

If you want to add another gametype, repeat these 
steps.

==========================

When all the tabs are configured, 
you are almost ready to go. Now the 
only thing that is left to do is 
to copy the MenuVote.ini from your local 
UnrealTournament\System directory to 
the UnrealTournament\System directory of 
your server. 

Then you are ready to go ! Switch to a map 
using the Menu Vote mutator by this console 
command while you are logged in:

admin switchlevel <mapname>?mutator=MenuVote.MV_Mutator

or you can also enable the mutator using 
the webadmin.

That's it, you're done !

How to use:
===========

While the installation was pretty 
difficult, using Menu Vote is a piece 
of cake. If you want to vote for an 
option, first press your vote key 
(that's configurable from the options 
menu of the mutator) or enter 
this console command:

mutate show menu

That will open the vote window. There, 
you can vote yes or no for a vote that 
is cast by someone else, or cast a 
vote yourself.

You can vote yes or no for a vote that is
cast by someone else by selecting the vote 
from the dropdown list in the top part of 
the window. Then, click the "Vote yes" or 
"Vote no" button to vote.

You can cast a new vote by entering an option 
in one of the different fields of the window. 
Not all fields may be available, due to the 
configuration of Menu Vote. Fields that are 
not activated are hidden. When you've entered 
an option to vote for, click the "Vote" button 
next to the option you entered. Note: you can 
only cast one vote at a time. 
You can cancel your own vote by selecting it 
from the dropdown list and hitting the "Cancel" 
button.

That is all, have fun voting !

Credits:
========

This program is written by Bart 'eXoR' Jansen
from eXoR's UnrealScript.

You can email me at eXoR@PlanetUnreal.Com
or visit my website at 
Http://www.planetunreal.com/exor/

Copyright:
==========

Menu Vote for Unreal Tournament is 
the property of Bart 'eXoR' Jansen (C) 2002. You 
can distribute the package freely on any medium 
including CD's that ship with magazines, as long 
as you leave the archive intact and notify eXoR 
at Exorcist@Gamepoint.Net. You are NOT allowed 
to sell this program.

Unreal Tournament 1999 - 2001 Epic Games Inc. 
Created by Epic Games, Inc. in collaboration 
with Digital Extremes. Unreal and the Unreal 
logos are trademarks of Epic Games, Inc. All 
rights reserved. All other trademarks are the 
property of their respective companies. 
Copyright  2000,  2001 Infogrames Entertainment 
S.A. All Rights Reserved.